Exclude

Syntax: @Exclude [attribute_name,]value[, value]

When used without the optional attribute_name, this command will have no effect if used in a procedure that is not tied to the relevant ATTRIBUTE, i.e. the 'default' attribute is the tied attribute.

The Exclude command allows list attribute values to be disabled from selection from the attribute value list box (i.e. they could not be selected by the run time user from menus, etc.). One or several values can be put in the exclude list, separated by commas.

The optional use of an attribute_name allows the command to be used in general procedures, without needing to be directly tied to an attribute.

The Value parameter(s) can be literal strings, list attributes, string variables or string arrays. There is also an enhanced mode of use for arrays which is expanded on below.

If the value parameter is omitted, then the command will have the opposite effect of resetting all previously excluded values back to full inclusion. However, this can only be done for one attribute at a time.

Example

@EXCLUDE 'JunMgr'

If an attribute called Grade had values Director, SenMgr and JunMgr, then this command would exclude JunMgr from user selection.

@EXCLUDE Grade, 'JunMgr'

This command will exclude the value held in JunMgr in the Grade attribute.

@EXCLUDE log[1,1],LogAtt

This command will exclude the value held in log[1,1] and also the value of LogAtt.

@EXCLUDE Grade

resets all values of the attribute Grade to inclusion.

Using Exclude with a string array

This alternative mode is invoked by putting a string array as the value, but ONLY putting the Knowledge Explorer name of the array (i.e. there are no element numbers or separators). The string array can contain a list of values to exclude terminated by a blank element. The exclusions are first cleared by the command in order to ignore any current exclusion that might be in effect, and the new values from the array list will then be excluded.

Example

@ASSIGN exclst[1] = 'Two'
@ASSIGN exclst[2] = 'Four'
@ASSIGN exclst[3] = ''
@EXCLUDE att1 , exclst

Is the same as:

@EXCLUDE att1 , ''
@EXCLUDE att1 , 'Two'
@EXCLUDE att1 , 'Four'